home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / tm104.zip / README.TM < prev    next >
Text File  |  1993-06-06  |  17KB  |  341 lines
  1. Hi All!
  2.  
  3. ~|~une /\/\aker  Version 1.04
  4. ~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~
  5.  
  6. [1] This programme is pretty useless if you do not have a copy of
  7.     Version 2.24+ of the Silver Xpress Off-Line Message Reader
  8.     produced by Hector Santos [the well-known GENIUS!!]. 
  9.  
  10. [2] The programme is simply designed to make it easier to create
  11.     tunes for Xpress Messages, by allowing you to create the tunes
  12.     and then writing the Dot Command Files for you. 
  13.  
  14. [3] The programme will also, if you wish, allow you to create a
  15.     file of raw C Code which will play the same tune. Please note,
  16.     though, that this is written for Turbo C  and other compilers
  17.     which do not have a sound() function or something similar (I
  18.     think QuickC doesn't) will not compile it. Also I have not
  19.     yet had time to create C Modules which will perform the same
  20.     functions as the Alarm, Siren, & Beep dot commands, and these
  21.     are not inserted into the C File.
  22.  
  23. [4] The programme should run on any IBM-compatible PC, but not, I'm
  24.     afraid, on anything else. Your Computer should be able to display
  25.     extended ascii characters, and must be capable of running in 80
  26.     Column Mode. Version 1.04 includes support for colour, but will
  27.     work perfectly okay in Black & White or Monochrome Modes.
  28.     ~|~une /\/\aker 1.04 requires approximately 95k free RAM to run.
  29.  
  30.     NOTE:- tune.exe now supports the following command-line switches:
  31.            /q or -q disables the initial Screen Frenzy and permits a
  32.                     FAST ENTRY into the programme for people using XT
  33.                     speed machines.
  34.            /m or -m disables colour (tune will normally display
  35.                     colour if your setup is capable of it) in case
  36.                     you prefer Black & White...
  37.  
  38.            These can precede or follow any file you specify but must
  39.            be seperated from the filespec by a space, eg:-
  40.            tune /q/m
  41.            tune -qm
  42.            tune bach.arr /q     are all okay......but
  43.  
  44.            tune/q        or
  45.            tune bach.arr/q      will NOT work!!!
  46.  
  47.     I have not included the raw code for the programme in this zip 
  48.     file (to save myself from embarassment as much as anything!!). 
  49.     If you would like it, it is available from the Time Tunnel, 
  50.     Bolton [UK] (2:250/106) (0204 596245). and the file is
  51.     TM104-C.ZIP.  ~|~une /\/\aker is written in Turbo C.
  52.  
  53. [5] The programme itself is very easy to use, as 5 octaves of notes
  54.     are programmed into it and all you have to do is to create the
  55.     tune from ear, as it were. Where you prompted for a delay or
  56.     duration, please note that this is in MILLISECONDS. The keys
  57.     that are available for use are shown at all times. There are
  58.     four basic areas of operation: Creating, Editing, Blocks, and the
  59.     Quit/Write/Save Area. 
  60.     
  61.     Creating allows you to add to an existing tune, but not to edit 
  62.     the rest except to delete the last recorded note. Editing allows 
  63.     you to edit the notes, or to add notes to the end (and you can
  64.     also insert them into the middle. At any time, you can save the
  65.     current tune and/or load a new/existing file and/or write the
  66.     various text files and/or change the output File Name. From 
  67.     Editing Mode it is possible to move, copy or delete whole 
  68.     blocks of notes.
  69.  
  70. [6] A couple of things to note:
  71.     (a) In either mode, if you insert a beep, siren, alarm, delay,
  72.         or no-sound into the tune, then if, when editing, you wish
  73.         to change that instruction back to a note, you must first
  74.         hit [M] to change it to a note.
  75.     (b) This program is designed to run on an 80x25 display. Whilst
  76.         it will run on 80x43 or 80x50, it will NOT run on anything
  77.         less. 
  78.     (c) Sorry if anyone finds the beeps and whistles annoying!! I
  79.         let myself get carried away a bit!!! <grin>. Similarly, I am
  80.         slightly spoilt by having written this on a 386, and the
  81.         Windowing Functions may work rather slowly on an XT!!!
  82.         If this is the case, use the /q command-line switch.
  83.     (d) I have included 2 demonstrations of what is possible
  84.         with the programme. To load these files (or any others),
  85.         simply give the name of the file (including any necessary
  86.         drive or path specifications) as a command line parameter.
  87.  
  88.     (e) What's new in Versions 1.03 and 1.04?
  89.          1.03  [1] Bug fix from 1.02:- Output File Name 
  90.                    for C and Dot Command Files now changed if 
  91.                    new file loaded from within the programme.             
  92.                [2] The Block Mode now allows Deletion and Moving 
  93.                    of Blocks as well as copying.                 
  94.                [3] The Edit Mode now allows you to increase the  
  95.                    size of the array by adding notes to the end  
  96.                    of the tune. An attempt to go beyond the end  
  97.                    of the tune no longer results in an error,    
  98.                    merely copies the last note and increases the 
  99.                    array and tune position indicators.           
  100.                [4] The Save/Write/Quit screen now allows you the 
  101.                    option of changing the output file names in   
  102.                    the middle of the programme.                  
  103.  
  104.          1.04  [1] Another Octave has been added below Bottom C. 
  105.                    The lower notes have been renamed accordingly.
  106.                [2] Command-line switches enabled to allow Quick
  107.                    start [/q] or to disable colour [/m]
  108.  
  109.  
  110. [7] INSTRUCTIONS:
  111.     =============
  112.  
  113.     (A) You only need tune.exe to run this. You may find it easier 
  114.         to give it its own directory, if you are going to want 
  115.         to save the tunes you've created.
  116.  
  117.     (B) Just hit [tune] to start Tune Maker. No parameters are
  118.         needed, but if you do not specify a file, then ~|~/\/\ will
  119.         load or create (as necessary) the default file which is
  120.         `xprtune.arr'. If you want to load a particular .arr file,
  121.         then simply give it as a parameter, (together with any path
  122.         if not in the current directory.
  123.  
  124.         If you want a quick rather than a spectaculer start, then use
  125.         the /q option, and if you want monochrome (despite the fact
  126.         that your system supports colour) then use the /m option.
  127.  
  128.     (C) After the starting screens, the program ends up giving you a
  129.         tone to work with. You are in effect being allowed to specify 
  130.         the first note of the tune (or the next if a tune is loaded
  131.         at startup) Available commands are displayed at the bottom
  132.         of the screen, and a status window at top left which gives
  133.         details about the current note. The bottom half of that status
  134.         window merely records the number of notes recorded at this stage.
  135.         If you have loaded an old tune, then you are put to the end
  136.         of the tune.
  137.  
  138.     (D) Creation Mode.
  139.         Notes are recorded into the array by hitting [RETURN]. Commands
  140.         available up to that point are as follows:-
  141.         
  142.         (1) Pitch Commands.
  143.         [UP-Arrow]   increases the pitch of the note by a semi-tone.
  144.         [DOWN-Arrow] decreases the pitch of the note by a semi-tone.
  145.         [Page-UP]    increases the pitch of the note by an Octave.
  146.         [Page-DOWN]  decreases the pitch of the note by an Octave.
  147.         [HOME]       sets the pitch of the note to Middle C.
  148.         [END]        sets the pitch of the note 2 octaves above Middle C.
  149.         
  150.         (2) Playback Commands.
  151.         [P] Plays back the last *recorded* note to you.
  152.         [T] Plays back the whole tune so far.
  153.  
  154.         (3) Special Function Commands.
  155.         [A] Inserts an Alarm. } Please note that these are *not* translated
  156.         [B] Inserts a Beep.   } into the C File, and are *not* played back.
  157.         [S] Inserts a Siren   } They *do* get put in the Dot Command File.
  158.  
  159.         [N] Inserts a [NO SOUND] Command.    } These useful for putting in
  160.         [D] Inserts a [DELAY] (Pause) Comand.} gaps between repeated notes.
  161.                                                                  
  162.         (4) Other Commands.
  163.         [BACKSPACE] Deletes the last recorded note and lets you create it
  164.                     afresh.
  165.         [RETURN] Records the note at the current pitch. Prompts you for
  166.                  the duration of the note.
  167.         [E] Puts you in Tune Editing Mode.
  168.         [ESC] Puts you in the Save/Load/Write/Quit Window.
  169.  
  170.  
  171.     (E) Editing Mode:
  172.         This places you at Note 1 in your tune and allows you to alter
  173.         the notes you have created. You can return to Creation Mode by
  174.         hitting [ESC]. Please note that these alterations are done `on
  175.         the fly' and you have no need to hit [RETURN] to record them.
  176.  
  177.         PLEASE NOTE THAT THE PROGRAMME PLAYS THE CURRENT NOTE BACK TO
  178.         YOU AFTER EACH KEY-PRESS. YOU SHOULD BE WARY OF ALLOWING THE
  179.         KEYBOARD TO AUTO-REPEAT WHEN IN EDITING MODE.
  180.  
  181.         Commands available in Editing Mode are as follows:-
  182.  
  183.         (1) Movement Commands.
  184.         [LEFT-Arrow]  moves to the previous note.
  185.         [RIGHT-Arrow] moves to the next note. If you try to go beyond
  186.                       the end of the tune, 1.04 now creates a
  187.                       duplicate of the previous note, and increases
  188.                       the size of the array accordingly, so you can
  189.                       now ad to the tune in Editing Mode.
  190.         [HOME] Moves to the start of the tune.
  191.         [END]  moves to the end of the tune.
  192.  
  193.         (2) Pitch & Delay Commands.
  194.         [UP-Arrow] Increases the pitch of the current note by a semitone.
  195.         [DOWN_Arrow] Decreases the pitch of the current note by a semitone.
  196.         [Page-UP] Increases the delay of the note by 10 milliseconds.
  197.         [Page-DOWN] Decreases the delay of the note by 10 milliseconds.
  198.         [PLUS] Increases the delay of the note by 50 ms.
  199.         [MINUS] Decreases the delay of the note by 50 ms.
  200.  
  201.         (3) Special Commands.
  202.         [C] Allows you to copy a Block of Characters.
  203.         [A] changes the current `note' to an Alarm.
  204.         [B] changes the current note to a Beep.
  205.         [S] changes the current note to a Siren.
  206.         [N] changes the current note to a [Nosound] Command.
  207.         [D] changes the current note to a [Delay] Command.
  208.         [M] changes the current note from any of the 5 above, back into a
  209.             note. It specifies Middle C for 500 ms and can be edited from 
  210.             there.
  211.         [INS] Inserts a space at the current position and moves the rest
  212.               of the tune up one. Again, it specifies Middle C for 500 ms.
  213.         [DEL] Deletes the CURRENT note from the tune and moves the rest
  214.               down one. Places you at the same position in the tune (ie:
  215.               what used to be the next note).
  216.         [ESC] Returns you to Creation Mode.
  217.  
  218.         (4) Playback commands.
  219.         [P] Plays back the current note again.
  220.         [T] Plays back the whole tune for you.
  221.  
  222.     (F) Block Mode.
  223.         At this point you can copy a block of notes/commands to any
  224.         other point in the Tune Array, move a Block about, or delete
  225.         a previously marked block. Simply use the left and right
  226.         cursor keys and [S], [E], & [D] keys to mark the Start, End,
  227.         and/or Destination of the Block, and then hit C to copy the
  228.         Block, M to move it, or the Keypad [MINUS] to delete it,
  229.         and return to Editing Mode. At any time you can hit
  230.         [ESC] to abort the operation and return to editing. You can
  231.         always reposition Block/Destination Markers before you hit
  232.         [C]. The operation places you at the end of the copied Block
  233.         when you return to editing.
  234.  
  235.         Note that the Destination is to the left of the note you
  236.         specify (ie: if you specify note 6 as the destination, then
  237.         the block will be copied or moved to between notes 5 & 6).
  238.         Blocks are inclusive of the Start and End Notes you specify.
  239.  
  240.     (G) Save/Load/Write/Quit Window.
  241.         This window allows you to write various files using the current
  242.         values, save the current values to Disc, to exit with or
  243.         without saving anything, or to return to creation mode. Just
  244.         hit the relevant letter to implement the command.
  245.  
  246.         (Q) Quit. Exits the program without saving anything further.
  247.  
  248.         (S) Save. Writes a file xxxxxxxx.ARR containing the current values
  249.                   of the tune. You are then returned to this menu. This
  250.                   is the file which the program itself uses to load old
  251.                   tunes, and in simply in a format "nnnn nnnn" being the
  252.                   frequency and duration factors. The special commands
  253.                   like delays, alarms, sirens etc, are shown by frequencies
  254.                   0 - 4 as follows:-
  255.                         "   0 nnnn" is a delay for a specified period.
  256.                         "   1    0" is an Alarm.
  257.                         "   2    0" is a Beep.
  258.                         "   3    0" is a Siren.
  259.                         "   4    0" is a (No-sound) Command.
  260.  
  261.         (L) Load. Puts up the Load Windows: On the left are the .ARR
  262.                   files contained in the CURRENT Directory, with the
  263.                   current file highlighted. Any of these can be 
  264.                   selected merely by entering the file name. If you 
  265.                   want to load a file not shown, then it's full path 
  266.                   should be given. To cancel and return to the
  267.                   previous window, just hit ENTER, otherwise the file
  268.                   you specify is loaded and you are returned to
  269.                   Creation Mode.
  270.  
  271.         (C) Write C File. Writes Turbo C Source Code to implement the
  272.                           tune using the current values. You can either
  273.                           compile this immediately, or incorporate it
  274.                           in another program. This ignores all the calls
  275.                           for Sirens, Alarms, etc, and is xxxxxxxx.C.
  276.                           The file #include's <dos.h> & <stdio.h>, 
  277.                           and consists of one `main()' function only.
  278.  
  279.         (W) Write Dot File. This writes a file with Silver Xpress Dot
  280.             Commands in, including all the Commands for Beeps, Sirens
  281.             etc, and the file is called xxxxxxxx.MSG. This is in the
  282.             exact format required by Silver Xpress and can simply be
  283.             incorporated into a message from within Xpress when editing
  284.             the message. Given the limitations of having to keep hitting
  285.             Page-Down when reading the message, it plays the tune exactly
  286.             as the TM Program or C Function, except that alarms etc are
  287.             included.
  288.  
  289.         (F) Change Output File Name. This displays a similar set of
  290.             screens to the New File Load ones, but simply allows you
  291.             to change the name of any files which you write but 
  292.             keeping the tune currently stored in the array. If this
  293.             option is chosen then the names of any future .c and .msg
  294.             files are also changed,
  295.  
  296.         (R) Return to Program. This simply puts you back to Creation Mode
  297.             with nothing further changed. This will allow you to come out
  298.             and save or write and then go back to editing etc.
  299.  
  300.  
  301. [8] This is now care-ware (!!). I originally wrote it solely for my
  302.     own use after Xpress 2.24 came out, but eventually got it to a
  303.     reasonable enough state where I thought someone else might find it
  304.     useful, so I released it, and it's developed from there. I would be 
  305.     grateful for feedback (either in the Xpress Echo or on Time Tunnel) 
  306.     on any bugs I've missed, or suggestions for ways in which the format 
  307.     of the programme could be improved. 
  308.  
  309.     If you really feel so bowled over by the brilliance of the
  310.     programme that you feel you have to make a contribution of some
  311.     sort <huge grin>, then please make a donation to the fund for
  312.     Royal Ulster Constabulary Widows & Orphans (or an equivalent
  313.     Police Charity if you're outside the UK).
  314.  
  315.     If anyone wants the creation of source code in a different language or
  316.     for a different C Compiler and can provide the relevant commands
  317.     and syntax required, I will be happy to incorporate that in the next
  318.     verion!!! 
  319.  
  320.     I just hope that you have as much fun using it as I had writing it!
  321.     ===================================================================    
  322.  
  323.     I must, however, record my thanks to my brother Paul for his
  324.     assistance with the Windowing Functions, especially Screen
  325.     Frenzy, and for his ever-available advice and technical support!
  326.  
  327.     Above all thank you, Hector, for Xpress 2.24+, without which none 
  328.     of this would be possible or worthwhile!!
  329.  
  330. Best Wishes,
  331.  __        __
  332. (__)liver |__larke.     19th April 1990.
  333. ~~~~~~~~~~~~~~~~~~~     ~~~~~~~~~~~~~~~~
  334.  
  335.  
  336.      
  337.  
  338.     
  339.     
  340.  
  341.